Delete Customer Package
This API is used to delete a package which is not attached to subscribers. Deactivation is done as a soft deletion procedure. A package cannot be deleted if at least one subscriber is connected to it. To delete a package, it should be detached from any subscriber up front. When a package is deleted, it cannot be recovered.
| Method | Path |
|---|---|
| DELETE | /api/v2/customer/{id}/package/{id} |
Eligibility
The requestor is eligible to delete a package created for sub-customer use. They are not eligible to delete any other packages.
API Request
Request Structure
Not applicable
API Response
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| errorCode | String | O | Failure code. |
| errorMessage | String | O | Failure detailed description. |
| content | Object | O | Array of main response body objects. Displayed when an API call is successful. For a failure, it will be empty. |
| pageable | Object | O | Paging information object. Displayed when an API call is successful. For a failure, it will be empty. |
Content
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| requestId | UUID | M | Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful, or failed. |
Pageable
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| page | Numeric | M | Page number. |
| size | Numeric | M | Page size. Number of requested elements per page. |
| totalPages | Numeric | M | Total amount of available pages per requested page size. |
| totalElements | Numeric | M | Total amount of retrieved elements. |
Error Codes
In addition to the general success and failure codes, the following error codes are possible:
| Code | Message |
|---|---|
| GLOBAL_1001 | Service unavailable. Please try again. |
| CUSTOMER_1002 | Customer does not exist. |
| CUSTOMER_1051 | Unknown package id. |
| CUSTOMER_1053 | Package deletion failure. It is not allowed to delete a package in use by subscribers. |
Examples
API Request
Not applicable
Response Body Success ACK
Copy
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body Failure NAK
Copy
{
"errorCode": "CUSTOMER_1053",
"errorMessage": "Package deletion failure. It is not allowed to delete a plan in use by subscribers",
"content": "",
"pageable": ""
}